/*===========================================================================
  Copyright (C) 2014 by the Okapi Framework contributors
-----------------------------------------------------------------------------
  This library is free software; you can redistribute it and/or modify it 
  under the terms of the GNU Lesser General Public License as published by 
  the Free Software Foundation; either version 2.1 of the License, or (at 
  your option) any later version.

  This library is distributed in the hope that it will be useful, but 
  WITHOUT ANY WARRANTY; without even the implied warranty of 
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 
  General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License 
  along with this library; if not, write to the Free Software Foundation, 
  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

  See also the full LGPL text here: http://www.gnu.org/copyleft/lesser.html
===========================================================================*/

package net.sf.okapi.lib.xliff2.its;

import net.sf.okapi.lib.xliff2.InvalidParameterException;
import net.sf.okapi.lib.xliff2.XLIFFException;

/**
 * Implements the <a href='http://www.w3.org/TR/its20/#allowedchars'>Allowed Characters</a> data category.
 */
public class AllowedCharacters extends DataCategory {

	private String allowedCharacters = ".";

	/**
	 * Creates a new {@link AllowedCharacters} object without initial data.
	 */
	public AllowedCharacters () {
		// Needed in some cases
	}

	/**
	 * Creates a new {@link AllowedCharacters} object with a value.
	 * @param allowedChars the value to set.
	 */
	public AllowedCharacters (String allowedChars) {
		setAllowedCharacters(allowedChars);
	}

	@Override
	public String getDataCategoryName () {
		return "allowed-characters";
	}
	
	@Override
	public void validate () {
		if ( allowedCharacters.isEmpty() ) return;
		if ( allowedCharacters.equals(".") ) return;
		if ( allowedCharacters.startsWith("[") && allowedCharacters.endsWith("]") ) return;
		// Else: likely incorrect
		throw new XLIFFException("Invalid regular expression for allowedCharacters.");
	}

	@Override
	public IITSItem createCopy () {
		AllowedCharacters newItem = new AllowedCharacters(allowedCharacters);
		newItem.setAnnotatorRef(getAnnotatorRef());
		return newItem;
	}

	/**
	 * Gets the expression for the allowed characters.
	 * @return the expression for the allowed characters (never null).
	 */
	public String getAllowedCharacters () {
		return allowedCharacters;
	}

	/**
	 * Sets the expression for the allowed characters.
	 * @param allowedCharacters the new expression for the allowed characters (cannot be null).
	 */
	public void setAllowedCharacters (String allowedCharacters) {
		if ( allowedCharacters == null ) {
			throw new InvalidParameterException("Allowed characters cannot be null.");
		}
		this.allowedCharacters = allowedCharacters;
	}

}
